SDK для Android

Обзор

SDK WAS VPS для Android включает готовые фрагменты Sceneform и вспомогательные классы, чтобы локализовать пользователей внутри карт VPS на устройствах с ARCore. Следуйте знакомому порядку: проверьте требования, подключите зависимость, настройте манифест и запустите сервис.

Требования

• Минимальный Android SDK 24 (Android 7.0)
• Устройство с поддержкой ARCore
• Проект на Kotlin (образцы написаны на Kotlin)

Нужен API ключ? Получите его на space.web-ar.studio или напишите на support@webar3.com / support@web-ar.studio.

Установка SDK

1. Убедитесь, что проект использует Maven Central:

   allprojects {
       repositories {
           mavenCentral()
           // другие репозитории…
       }
   }

2. Добавьте зависимость в модуль приложения:

   dependencies {
       implementation "com.arstudio:wasvps-sdk:1.0.0"
   }

3. Синхронизируйте Gradle.

Настройка манифеста

Добавьте требования ARCore и переопределите минимальный SDK при необходимости:

<!-- Разрешить использование WASVPS SDK при minSdk < 24 -->
<uses-sdk tools:overrideLibrary="com.arstudio.wasvps_sdk, com.google.ar.sceneform.sceneform, com.google.ar.sceneform.ux" />

<!-- Ограничить установку устройствами с ARCore (по умолчанию) -->
<uses-feature
    android:name="android.hardware.camera.ar"
    android:required="true" />

Чтобы расширить список поддерживаемых устройств, установите android:required="false" и сохраните атрибут tools:replace="android:required".

Быстрый старт с WASVPSArFragment

Разместите встроенный фрагмент в разметке активности:

<!-- res/layout/activity_main.xml -->
<androidx.fragment.app.FragmentContainerView
    android:id="@+id/vFragmentContainer"
    android:name="com.arstudio.wasvps_sdk.ui.WASVPSArFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        supportFragmentManager.beginTransaction()
            .replace(R.id.vFragmentContainer, WASVPSArFragment())
            .commit()
    }
}

Получите сервис и запустите локализацию, когда будут доступны Location ID:

val fragment = supportFragmentManager
    .findFragmentById(R.id.vFragmentContainer) as WASVPSArFragment

val config = WASVPSConfig.getIndoorConfig(listOf("your-location-id"))
val service = fragment.vpsService

service.setVpsConfig(config)
service.setVpsCallback(object : VpsCallback {
    override fun onSuccess() = Unit
    override fun onFail() = Unit
    override fun onStateChange(state: State) = Unit
    override fun onError(error: Throwable) {
        Log.e("VPS", "Localization error", error)
    }
})

service.startVpsService()

Останавливайте сервис через service.stopVpsService() например в onPause.

Кастомная интеграция фрагмента

Если вы используете собственный ArFragment или ArSceneView, создайте и настройте WASVPSService вручную:

class CustomArFragment : ArFragment() {
    private val vpsService = WASVPSService.newInstance()

    override fun onAttach(context: Context) {
        super.onAttach(context)
        WASVPSSdk.init(context.applicationContext)
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        vpsService.bindArSceneView(arSceneView)
        vpsService.setVpsConfig(WASVPSConfig.getOutdoorConfig(listOf("location-id")))
    }

    override fun onResume() {
        super.onResume()
        vpsService.resume()
        vpsService.startVpsService()
    }

    override fun onPause() {
        vpsService.pause()
        vpsService.stopVpsService()
        super.onPause()
    }

    override fun onDestroyView() {
        vpsService.destroy()
        super.onDestroyView()
    }
}

Размещение контента

Размещайте узлы относительно vpsService.worldNode. Всё, что находится под этим узлом, автоматически получит корректное глобальное положение после успешной локализации.

val anchorNode = Node().apply {
    setParent(vpsService.worldNode)
    localPosition = Vector3(0f, 0f, -1f)
}

Решение проблем

• Убедитесь, что на устройстве установлены и обновлены Google Play Services for AR.
• Если локализация не проходит, проверьте API-ключ, привязку Location ID и передачу конфигурации в сервис.
• Изучите модуль /sample в репозитории — там показаны полный жизненный цикл, работа с разрешениями и UI.